<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: include/trcDiagnostics.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.9.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('trcDiagnostics_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">trcDiagnostics.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Public trace diagnostic APIs.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;trcTypes.h&gt;</code><br />
</div>
<p><a href="trcDiagnostics_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af9e5f44c6191e70fc32c79d91e28c83f"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="trcDiagnostics_8h.html#af9e5f44c6191e70fc32c79d91e28c83f">xTraceDiagnosticsGet</a> (TraceDiagnosticsType_t xType, TraceBaseType_t *pxValue)</td></tr>
<tr class="memdesc:af9e5f44c6191e70fc32c79d91e28c83f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve diagnostics value.  <br /></td></tr>
<tr class="separator:af9e5f44c6191e70fc32c79d91e28c83f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8663f02f7a5a11b623a3182ce0464909"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="trcDiagnostics_8h.html#a8663f02f7a5a11b623a3182ce0464909">xTraceDiagnosticsSet</a> (TraceDiagnosticsType_t xType, TraceBaseType_t xValue)</td></tr>
<tr class="memdesc:a8663f02f7a5a11b623a3182ce0464909"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set diagnostics value.  <br /></td></tr>
<tr class="separator:a8663f02f7a5a11b623a3182ce0464909"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21f4cdae7b41b361b99242e927a36ca3"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="trcDiagnostics_8h.html#a21f4cdae7b41b361b99242e927a36ca3">xTraceDiagnosticsAdd</a> (TraceDiagnosticsType_t xType, TraceBaseType_t xValue)</td></tr>
<tr class="memdesc:a21f4cdae7b41b361b99242e927a36ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add to diagnostics value.  <br /></td></tr>
<tr class="separator:a21f4cdae7b41b361b99242e927a36ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a487dce9e02c0ac1a6ec842ea971875"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="trcDiagnostics_8h.html#a3a487dce9e02c0ac1a6ec842ea971875">xTraceDiagnosticsIncrease</a> (TraceDiagnosticsType_t xType)</td></tr>
<tr class="memdesc:a3a487dce9e02c0ac1a6ec842ea971875"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increase diagnostics value.  <br /></td></tr>
<tr class="separator:a3a487dce9e02c0ac1a6ec842ea971875"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a645f1442aad45717d66f694b9d644463"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="trcDiagnostics_8h.html#a645f1442aad45717d66f694b9d644463">xTraceDiagnosticsDecrease</a> (TraceDiagnosticsType_t xType)</td></tr>
<tr class="memdesc:a645f1442aad45717d66f694b9d644463"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrease diagnostics value.  <br /></td></tr>
<tr class="separator:a645f1442aad45717d66f694b9d644463"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9e17847a7689d40a59e9a930e2a8af9"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="trcDiagnostics_8h.html#ae9e17847a7689d40a59e9a930e2a8af9">xTraceDiagnosticsSetIfHigher</a> (TraceDiagnosticsType_t xType, TraceBaseType_t xValue)</td></tr>
<tr class="memdesc:ae9e17847a7689d40a59e9a930e2a8af9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a new diagnostics value if higher than previous value.  <br /></td></tr>
<tr class="separator:ae9e17847a7689d40a59e9a930e2a8af9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69fe97dcb698c1866c0d9d5566b0669d"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="trcDiagnostics_8h.html#a69fe97dcb698c1866c0d9d5566b0669d">xTraceDiagnosticsSetIfLower</a> (TraceDiagnosticsType_t xType, TraceBaseType_t xValue)</td></tr>
<tr class="memdesc:a69fe97dcb698c1866c0d9d5566b0669d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a new diagnostics value if lower than previous value.  <br /></td></tr>
<tr class="separator:a69fe97dcb698c1866c0d9d5566b0669d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2afded938b5e72ced2f7d7096aeed49"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="trcDiagnostics_8h.html#ac2afded938b5e72ced2f7d7096aeed49">xTraceDiagnosticsCheckStatus</a> (void)</td></tr>
<tr class="memdesc:ac2afded938b5e72ced2f7d7096aeed49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check the diagnostics status.  <br /></td></tr>
<tr class="separator:ac2afded938b5e72ced2f7d7096aeed49"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Public trace diagnostic APIs. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a21f4cdae7b41b361b99242e927a36ca3" name="a21f4cdae7b41b361b99242e927a36ca3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21f4cdae7b41b361b99242e927a36ca3">&#9670;&#160;</a></span>xTraceDiagnosticsAdd()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceDiagnosticsAdd </td>
          <td>(</td>
          <td class="paramtype">TraceDiagnosticsType_t&#160;</td>
          <td class="paramname"><em>xType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add to diagnostics value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xType</td><td>Diagnostics type </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xValue</td><td>Value</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ac2afded938b5e72ced2f7d7096aeed49" name="ac2afded938b5e72ced2f7d7096aeed49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2afded938b5e72ced2f7d7096aeed49">&#9670;&#160;</a></span>xTraceDiagnosticsCheckStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceDiagnosticsCheckStatus </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check the diagnostics status. </p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a645f1442aad45717d66f694b9d644463" name="a645f1442aad45717d66f694b9d644463"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a645f1442aad45717d66f694b9d644463">&#9670;&#160;</a></span>xTraceDiagnosticsDecrease()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceDiagnosticsDecrease </td>
          <td>(</td>
          <td class="paramtype">TraceDiagnosticsType_t&#160;</td>
          <td class="paramname"><em>xType</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Decrease diagnostics value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xType</td><td>Diagnostics type</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="af9e5f44c6191e70fc32c79d91e28c83f" name="af9e5f44c6191e70fc32c79d91e28c83f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9e5f44c6191e70fc32c79d91e28c83f">&#9670;&#160;</a></span>xTraceDiagnosticsGet()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceDiagnosticsGet </td>
          <td>(</td>
          <td class="paramtype">TraceDiagnosticsType_t&#160;</td>
          <td class="paramname"><em>xType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t *&#160;</td>
          <td class="paramname"><em>pxValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve diagnostics value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xType</td><td>Diagnostics type </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxValue</td><td>Pointer to value</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a3a487dce9e02c0ac1a6ec842ea971875" name="a3a487dce9e02c0ac1a6ec842ea971875"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a487dce9e02c0ac1a6ec842ea971875">&#9670;&#160;</a></span>xTraceDiagnosticsIncrease()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceDiagnosticsIncrease </td>
          <td>(</td>
          <td class="paramtype">TraceDiagnosticsType_t&#160;</td>
          <td class="paramname"><em>xType</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Increase diagnostics value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xType</td><td>Diagnostics type</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a8663f02f7a5a11b623a3182ce0464909" name="a8663f02f7a5a11b623a3182ce0464909"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8663f02f7a5a11b623a3182ce0464909">&#9670;&#160;</a></span>xTraceDiagnosticsSet()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceDiagnosticsSet </td>
          <td>(</td>
          <td class="paramtype">TraceDiagnosticsType_t&#160;</td>
          <td class="paramname"><em>xType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set diagnostics value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xType</td><td>Diagnostics type </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xValue</td><td>Value</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ae9e17847a7689d40a59e9a930e2a8af9" name="ae9e17847a7689d40a59e9a930e2a8af9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9e17847a7689d40a59e9a930e2a8af9">&#9670;&#160;</a></span>xTraceDiagnosticsSetIfHigher()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceDiagnosticsSetIfHigher </td>
          <td>(</td>
          <td class="paramtype">TraceDiagnosticsType_t&#160;</td>
          <td class="paramname"><em>xType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set a new diagnostics value if higher than previous value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xType</td><td>Dagnostics type </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xValue</td><td>Value</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a69fe97dcb698c1866c0d9d5566b0669d" name="a69fe97dcb698c1866c0d9d5566b0669d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69fe97dcb698c1866c0d9d5566b0669d">&#9670;&#160;</a></span>xTraceDiagnosticsSetIfLower()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceDiagnosticsSetIfLower </td>
          <td>(</td>
          <td class="paramtype">TraceDiagnosticsType_t&#160;</td>
          <td class="paramname"><em>xType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceBaseType_t&#160;</td>
          <td class="paramname"><em>xValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set a new diagnostics value if lower than previous value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xType</td><td>Dagnostics type </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">xValue</td><td>Value</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="trcDiagnostics_8h.html">trcDiagnostics.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
